package com.big.common.swagger.config;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpHeaders;

/**
 * <p>
 * Swagger配置
 * </p>
 *
 * @author 山归岿
 * @create 2025-06-21-19:37
 */
@Configuration
public class CustomizeSwaggerConfig {
    /**
     * 配置OpenAPI的基本信息
     * <p>
     * 此方法用于定义整个应用的接口文档信息，包括标题、描述、版本、联系方式和许可证信息
     *
     * @return OpenAPI 实例，包含应用接口文档的基本信息
     */
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("WZH Cloud接口文档")
                        .description("基于Spring Cloud Alibaba的微服务架构")
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("wzh")
                                .email("your-email@example.com")
                                .url("https://github.com/your-username"))
                        .license(new License()
                                .name("Apache 2.0")
                                .url("https://www.apache.org/licenses/LICENSE-2.0.html")))
                // 配置全局鉴权参数-Authorize
                .components(new Components()
                        .addSecuritySchemes(HttpHeaders.AUTHORIZATION,
                                new SecurityScheme()
                                        .name(HttpHeaders.AUTHORIZATION)
                                        .type(SecurityScheme.Type.APIKEY)
                                        .in(SecurityScheme.In.HEADER)
                                        .scheme("Bearer")
                                        .bearerFormat("JWT")
                        )
                );
    }

    /**
     * 配置公共API分组
     * <p>
     * 此方法用于定义一组名为'public'的API，这些API的路径匹配'/api/**'模式
     *
     * @return GroupedOpenApi 实例，代表公共API分组
     */
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("public")
                .pathsToMatch("/api/**")
                .build();
    }

    /**
     * 配置管理员API分组
     * <p>
     * 此方法用于定义一组名为'admin'的API，这些API的路径匹配'/admin/**'模式
     *
     * @return GroupedOpenApi 实例，代表管理员API分组
     */
    @Bean
    public GroupedOpenApi adminApi() {
        return GroupedOpenApi.builder()
                .group("admin")
                .pathsToMatch("/admin/**")
                .build();
    }

}
